/* Copyright 2007-2008 dnAnalytics Project.
 *
 * Contributors to this file:
 * Patrick van der Velde
 *
 * This file is part of dnAnalytics.  dnAnalytics is licensed under the 
 * Microsoft Public License. See License.txt for a complete copy of the
 * license.
 */

using System;

namespace dnAnalytics.LinearAlgebra.Solvers
{
    /// <summary>
    /// Indicates that a calculation has failed for some reason.
    /// </summary>
    public struct CalculationFailure : ICalculationStatus
    {
        /// <summary>
        /// Indicates if the current status warrants stopping the calculation.
        /// </summary>
        public bool TerminatesCalculation
        {
            get
            {
                return true;
            }
        }

        // TODO: CalcuationFailure - Indicate why the calculation has failed?
    }
}
